Gửi tin nhắn preview link
HTTP request
POST https://{app_id}.api.piscale.com/chat-bot/v1.0/messages
Request body
Ví dụ
{
"thread_id": "34161994212846",
"ext_user_ids": [],
"user_ids": [],
"body": {
"text": "Mọi người xem docs ở đây nè: https://docs.communi.io/docs/overview",
"metadata": [
{
"sitename": "docs.communi.io",
"description": "Communi Chat SDK cung cấp mọi thứ bạn cần để xây dựng trải nghiệm giao tiếp hấp dẫn trên ứng dụng của bạn, dành cho người dùng của bạn, theo cách mà bạn muốn",
"source_url": "https://docs.communi.io/docs/overview",
"source_thumb_url": "https://preview-image.piscale.com/https://docs.communi.io/img/sdk-social-card.png",
"title": "Welcome to Communi Chat SDK | Communi Chat SDK",
"type": "preview_link"
}
]
}
}
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
thread_id | string | Mã cuộc hội thoại | ✗ |
ext_user_ids | array | Danh sách ext_user_id | ✗ |
user_ids | array | Danh sách user_id | ✗ |
body.text | string | Nội dung văn bản | ✓ |
body.metadata | array | Danh sách hình ảnh | ✓ |
note
- Bắt buộc
thread_id
hoặcext_user_ids
hoặcuser_ids
phải có dữ liệu. - Đích đến của tin nhắn sẽ được ưu tiên theo thứ tự
thread_id
,ext_user_ids
,user_ids
. ext_user_ids
tối đa 1000 phần tử.user_ids
tối đa 100 phần tử.
Giải thích các thuộc tính của metadata:
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
type | string | Phải là "preview_link" | ✓ |
title | string | Tiêu đề | ✓ |
sitename | string | Tên site | ✓ |
description | string | Mô tả của site | ✓ |
source_url | string | Đường dẫn liên kết | ✓ |
source_thumb_url | string | Đường dẫn ảnh thumb | ✓ |
Response
Nếu thành công, bạn sẽ nhận được phản hồi.
Ví dụ
{
"message_code": "M200",
"message": "Success"
}
Tên | Kiểu dữ liệu | Mô tả |
---|---|---|
message_code | string | Mã thông điệp. Xem chi tiết |
message | string | Nội dung mã thông điệp |